API

Finance APIs

GET finance/fixed-assets

List of fixed assets

HTTP method GET
URI https://api.rambase.net/finance/fixed-assets
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 503, version 20

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

AssetId Integer Asset identifier.
BalanceGeneralLedgerAccountId Integer General ledger account identifier.
DepreciationGeneralLedgerAccountId Integer General ledger account identifier.
DepreciationRuleId Integer Depreciation rule identifier.
Description String Description of fixed asset.
FixedAssetId Integer Fixed asset identifier.
InvestmentGeneralLedgerAccountId Integer General ledger account identifier.
InvestmentReference String Investment reference of fixed asset..
Name String Name of fixed asset.
RuleDepreciationPeriods Integer Count of periods of depreciation rule.
Status Integer Status of fixed asset.

Read more about filters and sorting on how to use sortable parameters

AssetId Integer Asset identifier
BalanceGeneralLedgerAccountId Integer General ledger account identifier
DepreciationGeneralLedgerAccountId Integer General ledger account identifier
DepreciationRuleId Integer Depreciation rule identifier
Description String Description of fixed asset
FixedAssetId Integer Fixed asset identifier
InvestmentGeneralLedgerAccountId Integer General ledger account identifier
InvestmentReference String Investment reference of fixed asset.
Name String Name of fixed asset
RuleDepreciationPeriods Integer Count of periods of depreciation rule
Status Integer Status of fixed asset

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<FixedAssets>
2
     <FixedAsset>
3
          <FixedAssetId
FixedAssetId

Fixed asset identifier

>{Integer}</FixedAssetId>
4
          <Status
Status

Status of fixed asset

Possible domain values can be found here

>{Integer}</Status>
5
          <Name
Name

Name of fixed asset

>{String}</Name>
6
          <Description
Description

Description of fixed asset

>{String}</Description>
7
          <Investment
Investment

Investment details for the fixed asset

>
8
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
9
               <Amount
Amount

Represents the current investment amount of the fixed asset.

>{Decimal}</Amount>
10
               <Reference
Reference

Investment reference of fixed asset.

>{String}</Reference>
11
               <GeneralLedgerAccount>
12
                    <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
13
                    <Name
Name

Name of general ledger account

This field is greyed out because it is an expandable field. You have to add $expand=FixedAsset.Investment.GeneralLedgerAccount.Name in your request URI to get this field

>{String}</Name>
14
                    <AccountNumber
AccountNumber

The account number of the general ledger account

>{String}</AccountNumber>
15
                    <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
16
               </GeneralLedgerAccount>
17
          </Investment>
18
          <Depreciation
Depreciation

Depreciation details for the fixed asset

>
19
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
20
               <DepreciatedAmount
DepreciatedAmount

Represents the depreciated amount of the fixed asset.

>{Decimal}</DepreciatedAmount>
21
               <FirstPeriod
FirstPeriod

First depreciation period of the fixed asset

>{Integer}</FirstPeriod>
22
               <LastPeriod
LastPeriod

Last depreciation period of the fixed asset

>{Integer}</LastPeriod>
23
               <Rule>
24
                    <DepreciationRuleId
DepreciationRuleId

Depreciation rule identifier

>{Integer}</DepreciationRuleId>
25
                    <DepreciationPeriods
DepreciationPeriods

Count of periods of depreciation rule

>{Integer}</DepreciationPeriods>
26
                    <BalanceAccount>
27
                         <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
28
                         <Name
Name

Name of general ledger account

This field is greyed out because it is an expandable field. You have to add $expand=FixedAsset.Depreciation.Rule.BalanceAccount.Name in your request URI to get this field

>{String}</Name>
29
                         <AccountNumber
AccountNumber

The account number of the general ledger account

>{String}</AccountNumber>
30
                         <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
31
                    </BalanceAccount>
32
                    <DepreciationAccount>
33
                         <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
34
                         <Name
Name

Name of general ledger account

This field is greyed out because it is an expandable field. You have to add $expand=FixedAsset.Depreciation.Rule.DepreciationAccount.Name in your request URI to get this field

>{String}</Name>
35
                         <AccountNumber
AccountNumber

The account number of the general ledger account

>{String}</AccountNumber>
36
                         <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
37
                    </DepreciationAccount>
38
                    <DepreciationRuleLink
DepreciationRuleLink

Depreciation rule reference

>{String}</DepreciationRuleLink>
39
               </Rule>
40
          </Depreciation>
41
          <Balance>
42
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
43
               <Amount
Amount

Balance of fixed asset

>{Decimal}</Amount>
44
          </Balance>
45
          <FixedAssetLink
FixedAssetLink

Fixed asset reference

>{String}</FixedAssetLink>
46
     </FixedAsset>
47
     <Paging
Paging

Detailed paging information for this list.

>
48
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
49
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
50
          <Page
Page

Page index

>{Integer}</Page>
51
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
52
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
53
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
54
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
55
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
56
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
57
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
58
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
59
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
60
     </Paging>
61
</FixedAssets>
1
{
2
     "fixedAssets": [
3
          {
4
               "fixedAssetId
FixedAssetId

Fixed asset identifier

": "{Integer}",
5
               "status
Status

Status of fixed asset

Possible domain values can be found here

": "{Integer}",
6
               "name
Name

Name of fixed asset

": "{String}",
7
               "description
Description

Description of fixed asset

": "{String}",
8
               "investment
Investment

Investment details for the fixed asset

": {
9
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
10
                    "amount
Amount

Represents the current investment amount of the fixed asset.

": "{Decimal}",
11
                    "reference
Reference

Investment reference of fixed asset.

": "{String}",
12
                    "generalLedgerAccount": {
13
                         "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",
14
                         "name
Name

Name of general ledger account

This field is greyed out because it is an expandable field. You have to add $expand=FixedAsset.Investment.GeneralLedgerAccount.Name in your request URI to get this field

": "{String}",
15
                         "accountNumber
AccountNumber

The account number of the general ledger account

": "{String}",
16
                         "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
17
                    }
18
               },
19
               "depreciation
Depreciation

Depreciation details for the fixed asset

": {
20
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
21
                    "depreciatedAmount
DepreciatedAmount

Represents the depreciated amount of the fixed asset.

": "{Decimal}",
22
                    "firstPeriod
FirstPeriod

First depreciation period of the fixed asset

": "{Integer}",
23
                    "lastPeriod
LastPeriod

Last depreciation period of the fixed asset

": "{Integer}",
24
                    "rule": {
25
                         "depreciationRuleId
DepreciationRuleId

Depreciation rule identifier

": "{Integer}",
26
                         "depreciationPeriods
DepreciationPeriods

Count of periods of depreciation rule

": "{Integer}",
27
                         "balanceAccount": {
28
                              "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",
29
                              "name
Name

Name of general ledger account

This field is greyed out because it is an expandable field. You have to add $expand=FixedAsset.Depreciation.Rule.BalanceAccount.Name in your request URI to get this field

": "{String}",
30
                              "accountNumber
AccountNumber

The account number of the general ledger account

": "{String}",
31
                              "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
32
                         },
33
                         "depreciationAccount": {
34
                              "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",
35
                              "name
Name

Name of general ledger account

This field is greyed out because it is an expandable field. You have to add $expand=FixedAsset.Depreciation.Rule.DepreciationAccount.Name in your request URI to get this field

": "{String}",
36
                              "accountNumber
AccountNumber

The account number of the general ledger account

": "{String}",
37
                              "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
38
                         },
39
                         "depreciationRuleLink
DepreciationRuleLink

Depreciation rule reference

": "{String}"
40
                    }
41
               },
42
               "balance": {
43
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
44
                    "amount
Amount

Balance of fixed asset

": "{Decimal}"
45
               },
46
               "fixedAssetLink
FixedAssetLink

Fixed asset reference

": "{String}"
47
          }
48
     ],
49
     "paging
Paging

Detailed paging information for this list.

": {
50
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
51
          "position
Position

Position of the first element in the list

": "{Integer}",
52
          "page
Page

Page index

": "{Integer}",
53
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
54
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
55
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
56
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
57
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
58
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
59
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
60
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
61
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
62
     }
63
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100169 HTTP 404 General ledger account not found : {0}